/*
 * File     : Unsigned.java
 * Created  : 16 Apr 2011
 * Revision : $Revision$
 *
 * Copyright © 2006-9 Matthew Wilson (mj. {my-surname} .uk {at} gmail.com)
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
package com.googlecode.dni.type.nativetype;

import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * <p>
 *  Annotates a parameter or structure field's getter to indicate that a native
 *  type should be handled as unsigned.
 * </p>
 * <p>
 *  This annotation can only be used when the type is already annotated with
 *  {@link NativeChar} or {@link NativeShort}.  It deals with the case where a
 *  native type is promoted to a larger Java type; normally, the promotion is
 *  signed, but this annotation sets that promotion to be unsigned.
 *
 * @author Matthew Wilson
 */
@Retention( RetentionPolicy.RUNTIME )
@Target( { ElementType.METHOD, ElementType.PARAMETER } )
@Documented
// TODO can this be applied to a parameter??
public @interface Unsigned
{
    // nothing
}

